doc: clarifying variables in fs.write()#9792
Closed
jalafel wants to merge 1 commit intonodejs:masterfrom
Closed
Conversation
nodejs-github-bot
added
doc
Member
|
The variable names in the doc match those in the implementation in |
Contributor
I have trouble parsing your sentence, what is the "index length of a data structure"? I see length and size pretty much as synonyms. Use in node is consistent with Javascript, I believe: https://developer.mozilla.org/en-US/search?q=length&topic=api&topic=css&topic=html&topic=js&topic=apps&topic=webdev shows length is used as we use it, length also seems to be the preffered word in V8. length also seems common in python, size is arguably more common in C (but the last two aren't really relevant to node.js). I think the Your other textual changes look good. EDIT: I moved conversation back to the source issue #7868 (comment) |
jalafel
force-pushed
the
issue#7868
branch
4 times, most recently
from
dcad495 to
f031f14
Compare
This commit clarifies variables in the Filesystem docs. Prior, the documentation for fs.write() had an ambiguous remark on the parameters of offset and length. Therefore, this commit makes explicit that the length parameter in fs.write() is used to denote the number of bytes, which is a clearer reference for its usage. Ref: nodejs#7868
jalafel
changed the title
sam-github
approved these changes
Jan 16, 2017
|
Landed 762f260 |
italoacasas
pushed a commit
that referenced
this pull request
Jan 18, 2017
This commit clarifies variables in the Filesystem docs. Prior, the documentation for fs.write() had an ambiguous remark on the parameters of offset and length. Therefore, this commit makes explicit that the length parameter in fs.write() is used to denote the number of bytes, which is a clearer reference for its usage. PR-URL: #9792 Ref: #7868 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Jan 18, 2017
This commit clarifies variables in the Filesystem docs. Prior, the documentation for fs.write() had an ambiguous remark on the parameters of offset and length. Therefore, this commit makes explicit that the length parameter in fs.write() is used to denote the number of bytes, which is a clearer reference for its usage. PR-URL: nodejs#9792 Ref: nodejs#7868 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Jan 23, 2017
This commit clarifies variables in the Filesystem docs. Prior, the documentation for fs.write() had an ambiguous remark on the parameters of offset and length. Therefore, this commit makes explicit that the length parameter in fs.write() is used to denote the number of bytes, which is a clearer reference for its usage. PR-URL: nodejs#9792 Ref: nodejs#7868 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Jan 24, 2017
This commit clarifies variables in the Filesystem docs. Prior, the documentation for fs.write() had an ambiguous remark on the parameters of offset and length. Therefore, this commit makes explicit that the length parameter in fs.write() is used to denote the number of bytes, which is a clearer reference for its usage. PR-URL: nodejs#9792 Ref: nodejs#7868 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Jan 27, 2017
This commit clarifies variables in the Filesystem docs. Prior, the documentation for fs.write() had an ambiguous remark on the parameters of offset and length. Therefore, this commit makes explicit that the length parameter in fs.write() is used to denote the number of bytes, which is a clearer reference for its usage. PR-URL: nodejs#9792 Ref: nodejs#7868 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Mar 7, 2017
This commit clarifies variables in the Filesystem docs. Prior, the documentation for fs.write() had an ambiguous remark on the parameters of offset and length. Therefore, this commit makes explicit that the length parameter in fs.write() is used to denote the number of bytes, which is a clearer reference for its usage. PR-URL: #9792 Ref: #7868 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 7, 2017
This commit clarifies variables in the Filesystem docs. Prior, the documentation for fs.write() had an ambiguous remark on the parameters of offset and length. Therefore, this commit makes explicit that the length parameter in fs.write() is used to denote the number of bytes, which is a clearer reference for its usage. PR-URL: #9792 Ref: #7868 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 9, 2017
This commit clarifies variables in the Filesystem docs. Prior, the documentation for fs.write() had an ambiguous remark on the parameters of offset and length. Therefore, this commit makes explicit that the length parameter in fs.write() is used to denote the number of bytes, which is a clearer reference for its usage. PR-URL: #9792 Ref: #7868 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Mar 9, 2017
This commit clarifies variables in the Filesystem docs. Prior, the documentation for fs.write() had an ambiguous remark on the parameters of offset and length. Therefore, this commit makes explicit that the length parameter in fs.write() is used to denote the number of bytes, which is a clearer reference for its usage. PR-URL: #9792 Ref: #7868 Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Checklist
Affected core subsystem(s)
doc
Description of change
This commit clarifies variables in the Filesystem docs.
Prior, the documentation for fs.write() had an ambiguous
remark on the parameters of offset and length.
Therefore, this commit makes explicit that the length parameter
in fs.write() is used to denote the number of bytes, which is
a clearer reference for its usage.
Ref: #7868